@turf/boolean-intersects

What is @turf/boolean-intersects?

@turf/boolean-intersects is a module from the Turf.js library that provides geospatial analysis tools. This specific module is used to determine if two geometries intersect. It supports various types of geometries including points, lines, and polygons.

What are @turf/boolean-intersects's main functionalities?

Check if two polygons intersect

This feature checks if two polygons intersect. The code sample creates two polygons and uses the booleanIntersects function to determine if they intersect.

const turf = require('@turf/turf');

const polygon1 = turf.polygon([[
  [-2, 2],
  [2, 2],
  [2, -2],
  [-2, -2],
  [-2, 2]
]]);

const polygon2 = turf.polygon([[
  [1, 1],
  [3, 1],
  [3, -1],
  [1, -1],
  [1, 1]
]]);

const intersects = turf.booleanIntersects(polygon1, polygon2);
console.log(intersects); // true

Check if a line intersects a polygon

This feature checks if a line intersects a polygon. The code sample creates a line and a polygon and uses the booleanIntersects function to determine if they intersect.

const turf = require('@turf/turf');

const line = turf.lineString([
  [-1, 0],
  [1, 0]
]);

const polygon = turf.polygon([[
  [-2, 2],
  [2, 2],
  [2, -2],
  [-2, -2],
  [-2, 2]
]]);

const intersects = turf.booleanIntersects(line, polygon);
console.log(intersects); // true

Check if a point intersects a polygon

This feature checks if a point intersects a polygon. The code sample creates a point and a polygon and uses the booleanIntersects function to determine if they intersect.

const turf = require('@turf/turf');

const point = turf.point([1, 1]);

const polygon = turf.polygon([[
  [-2, 2],
  [2, 2],
  [2, -2],
  [-2, -2],
  [-2, 2]
]]);

const intersects = turf.booleanIntersects(point, polygon);
console.log(intersects); // true

Other packages similar to @turf/boolean-intersects

jsts

JSTS is a JavaScript library of spatial predicates and functions for processing geometry. It is a port of the Java Topology Suite (JTS). JSTS provides a wide range of geometric operations, including intersection checks, and is more comprehensive in terms of geometric processing compared to @turf/boolean-intersects.

martinez-polygon-clipping

Martinez Polygon Clipping is a library for performing boolean operations on polygons, such as union, intersection, difference, and xor. It is highly efficient and specifically designed for polygon operations, making it a good alternative for polygon intersection checks.

README

@turf/boolean-intersects

booleanIntersects

Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.

Parameters

• feature1 (Geometry | Feature<any>) GeoJSON Feature or Geometry

• feature2 (Geometry | Feature<any>) GeoJSON Feature or Geometry

• options Object Optional parameters (optional, default {})

  • options.ignoreSelfIntersections boolean ignores self-intersections on input features (optional, default false)

Examples

var point1 = turf.point([2, 2]);
var point2 = turf.point([1, 2]);
var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);

turf.booleanIntersects(line, point1);
//=false

turf.booleanIntersects(line, point2);
//=true

//addToMap
var addToMap = [point1, point2, line];
point1.properties['marker-color'] = '#f00'
point2.properties['marker-color'] = '#0f0'

Returns boolean true if geometries intersect, false otherwise

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this single module individually:

$ npm install @turf/boolean-intersects

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf